/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.common;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Various information about the HTTP request made available to the system.
 *
 * @author Jan Bernitt
 */
@Getter
@Builder( toBuilder = true )
@ToString
@EqualsAndHashCode
@AllArgsConstructor( access = AccessLevel.PRIVATE )
public final class RequestInfo
{

    @JsonProperty
    private final String headerXRequestID;

    /**
     * Since the xRequestID is a user provided input that will be used in logs
     * and potentially other places we need to make sure it is secure to be
     * used. Therefore, it is limited to unique identifier patterns such as UUID
     * strings or the UIDs used by DHIS2.
     *
     * A valid ID is alphanumeric (which dash and underscored being allowed too)
     * and has a length between 1 and 36.
     *
     * @param xRequestID the ID to check, may be null
     * @return true, if the provided ID is legal (null is legal) or false if it
     *         is not
     */
    public static boolean isValidXRequestID( String xRequestID )
    {
        return xRequestID == null || xRequestID.matches( "[-_a-zA-Z0-9]{1,36}" );
    }
}
